API Documentation
Classes | Typedefs | Enumerations
nkTasks Namespace Reference

Encompasses all API of component NilkinsTasks. More...

Classes

class  LambdaTask
 Utility task using lambda functions to submit work. More...
 
class  LogManager
 Responsible for logging all messages from the component. More...
 
class  Scheduler
 Allows to automate task submission to a set of threads. More...
 
class  Task
 A task, job that can be submitted to a nkTasks::Thread. More...
 
class  Thread
 Symbolizes a thread. Base block to submit off-thread nkTasks::Task in this component. More...
 
class  ThreadSubmittedWork
 Encompasses all needed information and control over a task that has been submitted. More...
 

Typedefs

using ThreadId = std::thread::id
 Symbolizes an id for a nkTasks::Thread.
 

Enumerations

enum  TASK_RESULT {
  TASK_RESULT::SUCCESS = 0, TASK_RESULT::CREATED, TASK_RESULT::ONGOING, TASK_RESULT::FAIL,
  TASK_RESULT::ABORT
}
 Symbolizes a task result code. More...
 

Detailed Description

Encompasses all API of component NilkinsTasks.

This component centralizes capabilities for threading. By overriding a nkTasks::Task to implement any wanted logic, it is then possible to submit it to a nkTasks::Thread. Another possibility is to instantiate a nkTasks::Scheduler and let it manage the submission of work over many threads.

Enumeration Type Documentation

◆ TASK_RESULT

enum nkTasks::TASK_RESULT
strong

Symbolizes a task result code.

Enumerator
SUCCESS 

Task succeeded.

CREATED 

Task has just been created.

ONGOING 

Task is currently being processed.

FAIL 

Task has failed in its processing.

ABORT 

Task has been aborted before being processed.